@npmcli/redact

What is @npmcli/redact?

@npmcli/redact is a utility for redacting sensitive information from strings. It is particularly useful for logging and debugging purposes where you want to ensure that sensitive data such as passwords, API keys, or personal information is not exposed.

What are @npmcli/redact's main functionalities?

Redact sensitive information

This feature allows you to redact specified sensitive information from a string. In this example, the words 'password' and 'secret' are redacted.

const { create } = require('@npmcli/redact');
const redactor = create(['password', 'secret']);
const redactedString = redactor('My password is password and my secret is secret.');
console.log(redactedString); // Output: My ****** is ****** and my ****** is ******.

Custom redaction patterns

This feature allows you to use custom regular expressions to define what should be redacted. In this example, a pattern for credit card numbers is used.

const { create } = require('@npmcli/redact');
const redactor = create([/\b\d{4}-\d{4}-\d{4}-\d{4}\b/]);
const redactedString = redactor('My credit card number is 1234-5678-1234-5678.');
console.log(redactedString); // Output: My credit card number is ********************.

Redact multiple patterns

This feature allows you to redact multiple patterns at once. In this example, both the word 'password' and a credit card number pattern are redacted.

const { create } = require('@npmcli/redact');
const redactor = create(['password', /\b\d{4}-\d{4}-\d{4}-\d{4}\b/]);
const redactedString = redactor('My password is password and my credit card number is 1234-5678-1234-5678.');
console.log(redactedString); // Output: My ****** is ****** and my credit card number is ********************.

Other packages similar to @npmcli/redact

redact-secrets

redact-secrets is a package that provides similar functionality for redacting sensitive information from strings. It allows for custom patterns and multiple redactions. Compared to @npmcli/redact, it offers a more flexible API for defining redaction rules.

redact-pii

redact-pii is focused on redacting personally identifiable information (PII) from strings. It comes with built-in patterns for common PII such as email addresses, phone numbers, and social security numbers. While @npmcli/redact is more general-purpose, redact-pii is specialized for PII.

log-sanitizer

log-sanitizer is a package designed to sanitize logs by redacting sensitive information. It supports custom patterns and multiple redactions similar to @npmcli/redact. However, it is specifically optimized for use in logging scenarios.

README

@npmcli/redact

Redact sensitive npm information from output.

API

This will redact npm_ prefixed tokens and UUIDs from values.

It will also replace passwords in stringified URLs.

redact(string)

Redact values from a single value

const { redact } = require('@npmcli/redact')

redact('https://user:[e-mail]/')
// https://user:***@registry.npmjs.org/

redact(`https://registry.npmjs.org/path/npm_${'a'.repeat('36')}`)
// https://registry.npmjs.org/path/npm_***

redactLog(string | string[])

Redact values from a string or array of strings.

This method will also split all strings on \s and = and iterate over them.

const { redactLog } = require('@npmcli/redact')

redactLog([
  'Something --x=https://user:[e-mail]/ foo bar',
  '--url=http://foo:[e-mail]',
])
// [
//   'Something --x=https://user:***@registry.npmjs.org/ foo bar',
//   '--url=http://foo:***@registry.npmjs.org/',
// ]

Changelog

2.0.1 (2024-06-05)

Bug Fixes

• 670847f #15 filter properties of error (#15) (@reggi)
• 826b60d #14 prevent redact for buffers (#14) (@reggi)